Skip to content

feat: Set up NGF integration to N1 Console #902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Set up NGF integration to N1 Console #902

wants to merge 4 commits into from

Conversation

mjang
Copy link
Contributor

@mjang mjang commented Jul 29, 2025 •
edited
Loading

I'm calling this a Working draft, to make it easier for our developers to use this as a test template of sorts

Proposed changes

Set up NGF integration into N1 Console.

  • This is similar to https://docs.nginx.com/nginx-one/k8s/add-nic/
    • But since NIC != NGF, I've changed labels / titles as appropriate
    • I've included some of the same steps to set up a data plane key, create a k8s secret, verify a connection, and for troubleshooting (I'm guessing the troubleshooting section, if applicable, will be different)
  • Many of the steps are the same with https://docs.nginx.com/nginx-gateway-fabric/install/helm/
    • I've added an include for one process, I've copy/pasted content with an include for a second process
  • I've included temporary references <!-- in comments --> to the UI and steps that we're using in that process

The primary build page is here: https://frontdoor-test-docs.nginx.com/previews/docs/902/nginx-one/k8s/add-ngf/

I think there's work to be done w/r/t data plane keys. We have a bunch of different ways to create them

  • There's an alert for when a data plane key is within 30 days of expiration
  • This may be best as a separate issue

This might close issue 660.
Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric product/nginx-one Issues related to NGINX One Console labels Jul 29, 2025
@github-actions GitHub Actions
Copy link

✅ Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/902/

@mjang mjang changed the title DRAFt feat: Set up NGF integration to N1 Console DRAFT feat: Set up NGF integration to N1 Console Jul 29, 2025
@mjang mjang self-assigned this Jul 29, 2025
@mjang mjang changed the title DRAFT feat: Set up NGF integration to N1 Console Working draft: Set up NGF integration to N1 Console Jul 29, 2025
@mjang
Copy link
Contributor Author

mjang commented Jul 29, 2025

cc @sylwang @bjee19

bjee19
bjee19 reviewed Jul 30, 2025
View reviewed changes
bjee19
bjee19 reviewed Jul 30, 2025
View reviewed changes
mjang
mjang commented Aug 6, 2025
View reviewed changes
@mjang mjang marked this pull request as ready for review August 6, 2025 14:09
@mjang mjang requested a review from a team as a code owner August 6, 2025 14:09
@mjang mjang changed the title Working draft: Set up NGF integration to N1 Console Set up NGF integration to N1 Console Aug 6, 2025
@mjang mjang changed the title Set up NGF integration to N1 Console feat: Set up NGF integration to N1 Console Aug 6, 2025
bjee19
bjee19 requested changes Aug 6, 2025
View reviewed changes
content/nginx-one/k8s/add-ngf.md
Comment on lines +75 to +64
## Install from the OCI registry
<!-- Corresponds to step 3 in the UX -->
{{< include "/ngf/installation/install-oci-registry.md" >}}

### Install from sources {#install-from-sources}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need to include setting the flag specifying the secret name when installing through Helm for all the commands,

--set nginx.nginxOneConsole.dataplaneKeySecretName=<data_plane_key_secret_name>

Like they do in NIC.

We can also specify through manifests they need to add the --nginx-one-dataplane-key-secret=<data_plane_key_secret_name> argument on the NGF deployment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bjee19 can you be more specific? I don't see examples where we use

  • --set nginx.nginxOneConsole.dataplaneKeySecretName=<data_plane_key_secret_name>
  • --nginx-one-dataplane-key-secret=<data_plane_key_secret_name>

In our NIC docs

Copy link
Contributor

@sylwang sylwang Aug 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is where we use a similar --set flag to set these parameters in the NIC docs:
https://docs.nginx.com/nginx-one/k8s/add-nic/

Below is the command mentioned in the NIC doc:

helm upgrade --install my-release oci://ghcr.io/nginx/charts/nginx-ingress --version 2.2.1 \
  --set nginxAgent.enable=true \
  --set nginxAgent.dataplaneKeySecretName=<data_plane_key_secret_name> \
  --set nginxAgent.endpointHost=agent.connect.nginx.com

There was also a question about the consistency (using nginx.nginxAgent versus nginx.nginxOneConsole) in this slack discussion: https://f5.slack.com/archives/C07RT2VUTBL/p1755121421428819
We decided that this is not a concern since NGINX Agent has a bigger presence/use in NIC.

n-pandey-f5
n-pandey-f5 reviewed Aug 11, 2025
View reviewed changes
@sylwang
Copy link
Contributor

sylwang commented Aug 11, 2025

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design.
https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

ADubhlaoich
ADubhlaoich reviewed Aug 12, 2025
View reviewed changes
mjang
mjang commented Aug 13, 2025
View reviewed changes
@mjang mjang requested a review from bjee19 August 13, 2025 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ADubhlaoich ADubhlaoich ADubhlaoich left review comments

@sjberman sjberman sjberman left review comments

@n-pandey-f5 n-pandey-f5 n-pandey-f5 left review comments

@sylwang sylwang sylwang left review comments

@bjee19 bjee19 Awaiting requested review from bjee19

Requested changes must be addressed to merge this pull request.

Assignees

@mjang mjang

Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric product/nginx-one Issues related to NGINX One Console
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@mjang @sylwang @ADubhlaoich @sjberman @n-pandey-f5 @bjee19